<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />
	<meta name="robots" content="noindex" />

	<title>File Plugin/DebugKit/Lib/DebugMemory.php</title>

	<script type="text/javascript" src="resources/combined.js?394153670"></script>
	<script type="text/javascript" src="elementlist.js?1800566221"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-abismo.html">abismo<span></span></a>
						<ul>
				<li><a href="package-abismo.admin.html">admin</a>
						</li>
				<li><a href="package-abismo.home.html">home</a>
						</li>
				<li><a href="package-abismo.images.html">images</a>
						</li>
				<li><a href="package-abismo.projects.html">projects</a>
						</li>
				<li><a href="package-abismo.Services.html">Services</a>
						</li>
				<li><a href="package-abismo.studio.html">studio</a>
						</li>
				<li><a href="package-abismo.tenders.html">tenders</a>
						</li>
				<li><a href="package-abismo.users.html">users</a>
						</li>
				<li><a href="package-abismo.videos.html">videos</a>
						</li>
				<li><a href="package-abismo.view.html">view<span></span></a>
						<ul>
				<li><a href="package-abismo.view.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-app.html">app<span></span></a>
						<ul>
				<li><a href="package-app.Config.html">Config<span></span></a>
						<ul>
				<li><a href="package-app.Config.Schema.html">Schema</a>
						</li>
							</ul></li>
				<li><a href="package-app.Model.html">Model<span></span></a>
						<ul>
				<li><a href="package-app.Model.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-app.Model.debug.kit.html">kit</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-app.View.html">View<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.html">Helper<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.views.html">views<span></span></a>
						<ul>
				<li><a href="package-app.View.Helper.debug.kit.views.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li></ul></li></ul></li></ul></li></ul></li>
				<li><a href="package-cake.html">cake<span></span></a>
						<ul>
				<li><a href="package-cake.debug.html">debug<span></span></a>
						<ul>
				<li><a href="package-cake.debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-cake.debug.kit.panels.html">panels</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li class="active"><a href="package-debug.html">debug<span></span></a>
						<ul>
				<li class="active"><a href="package-debug.kit.html">kit<span></span></a>
						<ul>
				<li><a href="package-debug.kit.components.html">components</a>
						</li>
				<li><a href="package-debug.kit.controllers.html">controllers<span></span></a>
						<ul>
				<li><a href="package-debug.kit.controllers.components.html">components</a>
						</li>
							</ul></li>
				<li class="active"><a href="package-debug.kit.Lib.html">Lib</a>
						</li>
				<li><a href="package-debug.kit.models.html">models<span></span></a>
						<ul>
				<li><a href="package-debug.kit.models.behaviors.html">behaviors</a>
						</li>
							</ul></li>
				<li><a href="package-debug.kit.vendors.html">vendors</a>
						</li>
				<li><a href="package-debug.kit.views.html">views<span></span></a>
						<ul>
				<li><a href="package-debug.kit.views.helpers.html">helpers</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li><a href="package-localized.html">localized</a>
						</li>
				<li><a href="package-Localized.html">Localized<span></span></a>
						<ul>
				<li><a href="package-localized.tests.html">tests<span></span></a>
						<ul>
				<li><a href="package-localized.tests.cases.html">cases<span></span></a>
						<ul>
				<li><a href="package-localized.tests.cases.libs.html">libs</a>
						</li>
							</ul></li></ul></li>
				<li><a href="package-Localized.Validation.html">Validation</a>
						</li>
							</ul></li>
				<li><a href="package-None.html">None</a>
						</li>
				<li><a href="package-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-DebugMemory.html">DebugMemory</a></li>
				<li><a href="class-DebugTimer.html">DebugTimer</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-debug.kit.Lib.html" title="Summary of debug\kit\Lib"><span>Package</span></a>
			</li>
			<li>
				<a href="class-DebugMemory.html" title="Summary of DebugMemory"><span>Class</span></a>
			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/**
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Contains methods for Profiling memory usage.
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> *
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * PHP versions 5
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> *
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> *
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * Licensed under The MIT License
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * Redistributions of files must retain the above copyright notice.
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment"> *
</span></span><span id="13" class="l"><a class="l" href="#13">13: </a><span class="php-comment"> * @copyright     Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> * @link          http://cakephp.org
</span></span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-comment"> * @package       debug_kit
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment"> * @subpackage    debug_kit.Lib
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment"> * @since         DebugKit 2.0
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment"> * @license       MIT License (http://www.opensource.org/licenses/mit-license.php)
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> */</span>
</span><span id="20" class="l"><a class="l" href="#20">20: </a>App::uses(<span class="php-quote">'Debugger'</span>, <span class="php-quote">'Utility'</span>);
</span><span id="21" class="l"><a class="l" href="#21">21: </a>
</span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-keyword1">class</span> <a id="DebugMemory" href="#DebugMemory">DebugMemory</a> {
</span><span id="23" class="l"><a class="l" href="#23">23: </a>
</span><span id="24" class="l"><a class="l" href="#24">24: </a><span class="php-comment">/**
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment"> * An array of recorded memory use points.
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment"> *
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment"> * @var array
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment"> */</span>
</span><span id="29" class="l"><a class="l" href="#29">29: </a>    <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$_points" href="#$_points">$_points</a></span> = <span class="php-keyword1">array</span>();
</span><span id="30" class="l"><a class="l" href="#30">30: </a>
</span><span id="31" class="l"><a class="l" href="#31">31: </a><span class="php-comment">/**
</span></span><span id="32" class="l"><a class="l" href="#32">32: </a><span class="php-comment"> * Get current memory usage
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment"> *
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment"> * @return integer number of bytes ram currently in use. 0 if memory_get_usage() is not available.
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment"> */</span>
</span><span id="36" class="l"><a class="l" href="#36">36: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getCurrent" href="#_getCurrent">getCurrent</a>() {
</span><span id="37" class="l"><a class="l" href="#37">37: </a>        <span class="php-keyword1">return</span> <span class="php-keyword2">memory_get_usage</span>();
</span><span id="38" class="l"><a class="l" href="#38">38: </a>    }
</span><span id="39" class="l"><a class="l" href="#39">39: </a>
</span><span id="40" class="l"><a class="l" href="#40">40: </a><span class="php-comment">/**
</span></span><span id="41" class="l"><a class="l" href="#41">41: </a><span class="php-comment"> * Get peak memory use
</span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment"> *
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment"> * @return integer peak memory use (in bytes). Returns 0 if memory_get_peak_usage() is not available
</span></span><span id="44" class="l"><a class="l" href="#44">44: </a><span class="php-comment"> */</span>
</span><span id="45" class="l"><a class="l" href="#45">45: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getPeak" href="#_getPeak">getPeak</a>() {
</span><span id="46" class="l"><a class="l" href="#46">46: </a>        <span class="php-keyword1">return</span> <span class="php-keyword2">memory_get_peak_usage</span>();
</span><span id="47" class="l"><a class="l" href="#47">47: </a>    }
</span><span id="48" class="l"><a class="l" href="#48">48: </a>
</span><span id="49" class="l"><a class="l" href="#49">49: </a><span class="php-comment">/**
</span></span><span id="50" class="l"><a class="l" href="#50">50: </a><span class="php-comment"> * Stores a memory point in the internal tracker.
</span></span><span id="51" class="l"><a class="l" href="#51">51: </a><span class="php-comment"> * Takes a optional message name which can be used to identify the memory point.
</span></span><span id="52" class="l"><a class="l" href="#52">52: </a><span class="php-comment"> * If no message is supplied a debug_backtrace will be done to identifty the memory point.
</span></span><span id="53" class="l"><a class="l" href="#53">53: </a><span class="php-comment"> *
</span></span><span id="54" class="l"><a class="l" href="#54">54: </a><span class="php-comment"> * @param string $message Message to identify this memory point.
</span></span><span id="55" class="l"><a class="l" href="#55">55: </a><span class="php-comment"> * @return boolean
</span></span><span id="56" class="l"><a class="l" href="#56">56: </a><span class="php-comment"> */</span>
</span><span id="57" class="l"><a class="l" href="#57">57: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_record" href="#_record">record</a>(<span class="php-var">$message</span> = <span class="php-keyword1">null</span>) {
</span><span id="58" class="l"><a class="l" href="#58">58: </a>        <span class="php-var">$memoryUse</span> = self::getCurrent();
</span><span id="59" class="l"><a class="l" href="#59">59: </a>        <span class="php-keyword1">if</span> (!<span class="php-var">$message</span>) {
</span><span id="60" class="l"><a class="l" href="#60">60: </a>            <span class="php-var">$named</span> = <span class="php-keyword1">false</span>;
</span><span id="61" class="l"><a class="l" href="#61">61: </a>            <span class="php-var">$trace</span> = <span class="php-keyword2">debug_backtrace</span>();
</span><span id="62" class="l"><a class="l" href="#62">62: </a>            <span class="php-var">$message</span> = Debugger::trimpath(<span class="php-var">$trace</span>[<span class="php-num">0</span>][<span class="php-quote">'file'</span>]) . <span class="php-quote">' line '</span> . <span class="php-var">$trace</span>[<span class="php-num">0</span>][<span class="php-quote">'line'</span>];
</span><span id="63" class="l"><a class="l" href="#63">63: </a>        }
</span><span id="64" class="l"><a class="l" href="#64">64: </a>        <span class="php-keyword1">if</span> (<span class="php-keyword1">isset</span>(self::<span class="php-var">$_points</span>[<span class="php-var">$message</span>])) {
</span><span id="65" class="l"><a class="l" href="#65">65: </a>            <span class="php-var">$originalMessage</span> = <span class="php-var">$message</span>;
</span><span id="66" class="l"><a class="l" href="#66">66: </a>            <span class="php-var">$i</span> = <span class="php-num">1</span>;
</span><span id="67" class="l"><a class="l" href="#67">67: </a>            <span class="php-keyword1">while</span> (<span class="php-keyword1">isset</span>(self::<span class="php-var">$_points</span>[<span class="php-var">$message</span>])) {
</span><span id="68" class="l"><a class="l" href="#68">68: </a>                <span class="php-var">$i</span>++;
</span><span id="69" class="l"><a class="l" href="#69">69: </a>                <span class="php-var">$message</span> = <span class="php-var">$originalMessage</span> . <span class="php-quote">' #'</span> . <span class="php-var">$i</span>;
</span><span id="70" class="l"><a class="l" href="#70">70: </a>            }
</span><span id="71" class="l"><a class="l" href="#71">71: </a>        }
</span><span id="72" class="l"><a class="l" href="#72">72: </a>        self::<span class="php-var">$_points</span>[<span class="php-var">$message</span>] = <span class="php-var">$memoryUse</span>;
</span><span id="73" class="l"><a class="l" href="#73">73: </a>        <span class="php-keyword1">return</span> <span class="php-keyword1">true</span>;
</span><span id="74" class="l"><a class="l" href="#74">74: </a>    }
</span><span id="75" class="l"><a class="l" href="#75">75: </a>
</span><span id="76" class="l"><a class="l" href="#76">76: </a><span class="php-comment">/**
</span></span><span id="77" class="l"><a class="l" href="#77">77: </a><span class="php-comment"> * Get all the stored memory points
</span></span><span id="78" class="l"><a class="l" href="#78">78: </a><span class="php-comment"> *
</span></span><span id="79" class="l"><a class="l" href="#79">79: </a><span class="php-comment"> * @param boolean $clear Whether you want to clear the memory points as well. Defaults to false.
</span></span><span id="80" class="l"><a class="l" href="#80">80: </a><span class="php-comment"> * @return array Array of memory marks stored so far.
</span></span><span id="81" class="l"><a class="l" href="#81">81: </a><span class="php-comment"> */</span>
</span><span id="82" class="l"><a class="l" href="#82">82: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getAll" href="#_getAll">getAll</a>(<span class="php-var">$clear</span> = <span class="php-keyword1">false</span>) {
</span><span id="83" class="l"><a class="l" href="#83">83: </a>        <span class="php-var">$marks</span> = self::<span class="php-var">$_points</span>;
</span><span id="84" class="l"><a class="l" href="#84">84: </a>        <span class="php-keyword1">if</span> (<span class="php-var">$clear</span>) {
</span><span id="85" class="l"><a class="l" href="#85">85: </a>            self::<span class="php-var">$_points</span> = <span class="php-keyword1">array</span>();
</span><span id="86" class="l"><a class="l" href="#86">86: </a>        }
</span><span id="87" class="l"><a class="l" href="#87">87: </a>        <span class="php-keyword1">return</span> <span class="php-var">$marks</span>;
</span><span id="88" class="l"><a class="l" href="#88">88: </a>    }
</span><span id="89" class="l"><a class="l" href="#89">89: </a><span class="php-comment">/**
</span></span><span id="90" class="l"><a class="l" href="#90">90: </a><span class="php-comment"> * Clear out any existing memory points
</span></span><span id="91" class="l"><a class="l" href="#91">91: </a><span class="php-comment"> *
</span></span><span id="92" class="l"><a class="l" href="#92">92: </a><span class="php-comment"> * @return void
</span></span><span id="93" class="l"><a class="l" href="#93">93: </a><span class="php-comment"> */</span>
</span><span id="94" class="l"><a class="l" href="#94">94: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_clear" href="#_clear">clear</a>() {
</span><span id="95" class="l"><a class="l" href="#95">95: </a>        self::<span class="php-var">$_points</span> = <span class="php-keyword1">array</span>();
</span><span id="96" class="l"><a class="l" href="#96">96: </a>    }
</span><span id="97" class="l"><a class="l" href="#97">97: </a>
</span><span id="98" class="l"><a class="l" href="#98">98: </a>}
</span><span id="99" class="l"><a class="l" href="#99">99: </a></span></code></pre>

	<div id="footer">
		 API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
